FlowTimer
The FlowTimer class is responsible for managing timeout properties and related settings in the workflow. It provides options for calculating timeouts using holidays, working hours, and other settings.
Properties
| Name | Description |
|---|---|
| Key | A unique identifier for the workflow step. |
| WorkflowCodeInstance | The workflow code instance associated with the flow object. |
| CachedDMObjects | The cached document management objects related to the flow object. |
| TypeCode | The type code associated with the flow object. |
| TimeoutHour | The hour associated with the timeout settings. |
| TimeoutDuration | The overall duration of the timeout as a TimeSpan object. |
| TimeoutOptions | The options related to the timeout settings, including how to calculate timeouts based on holidays, working hours, and other criteria. |
| TimeoutDay | The day associated with the timeout settings. |
| Name | Name for the workflow step. |
| CalculateUsingWorkingHours | Indicates whether the timeout should be calculated considering working hours. |
| TimeoutMinute | The minute associated with the timeout settings. |
| CalculateUsingHolidays | Indicates whether the timeout should be calculated considering holidays. |
| Caption | The caption dictionary representing localized captions for the flow object. |
Constructors
| Name | Description |
|---|---|
| FlowTimer(name, workflowData, workflowCodeInstance) | Constructor for the FlowTimer class. Initializes a new instance of the FlowTimer class. |
| FlowTimer(name, workflowData, workflowCodeInstance) | Constructor for the FlowTimer class. Initializes a new instance of the FlowTimer class. |
Methods
| Name | Description |
|---|---|
| Initialize() | Initializes the flow timer. This method is an implementation of the abstract Initialize method from the base class. |
| SendRequestTimedOutWebNotification(userInfo, requestItem) | #import (Bimser.CSP.Workflow.Api.Steps.FlowGroup.SendRequestTimedOutWebNotification(UserInfo,ProcessRequestItem)) (shortDescription) |
Events
| Name | Description |
|---|---|
| OnBeforeExecution(sender, args) | Occurs before the execution of the workflow step. |
| OnAfterExecution(sender, args) | Occurs after the execution of the workflow step. |
Generic Types
| Name | Description |
|---|---|
| TProperties | Generic type of properties. |